#
# peerscape.profile.name
#
# Copyright 2008 Helsinki Institute for Information Technology
# and the authors.
#
# Authors: Ken Rimey <rimey@hiit.fi>
#

# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

"""
Get or set name of person or group.

>>> from peerscape import DB
>>> db = DB()
>>> p = db.init_persona('test user')
>>> db.get_profile_name(p)
u'test user'

>>> db.set_profile_name(p, u'Test User')
>>> db.get_profile_name(p)
u'Test User'

>>> db.get_last_event(p)['comment']
u'Changed name from "test user".'

>>> db.set_profile_name(p, u'Test User')
>>> db.get_last_event(p)['comment']
u'Changed name from "test user".'

>>> db.close()
"""

from __future__ import with_statement

PATH = '/info/title.txt'

class ProfileNameDBMixin(object):
    def get_profile_name(self, iid):
        """Return the name as Unicode text."""
        return self.get_text(iid, PATH)

    def set_profile_name(self, iid, text):
        """Set the name to the provided Unicode text."""
        with self.write_transaction():
            old_name = self.get_profile_name(iid)
            if text != old_name:
                self.put(iid, PATH, text)
                self.post_event(iid, 'Changed name from "%s".' % old_name)

if __name__ == '__main__':
    import doctest
    doctest.testmod()
